Change the way we link to appendices (xref instead of link)
authorparkrrrr <parkrrrr>
Fri, 19 May 2006 20:28:30 +0000 (20:28 +0000)
committerparkrrrr <parkrrrr>
Fri, 19 May 2006 20:28:30 +0000 (20:28 +0000)
Document xcsv's options, since they're used so many places.

xmldoc/formats/custom.xml
xmldoc/formats/options/garmin_txt-datum.xml
xmldoc/formats/options/xcsv-prefer_shortnames.xml
xmldoc/formats/options/xcsv-snlen.xml
xmldoc/formats/options/xcsv-snunique.xml
xmldoc/formats/options/xcsv-snupper.xml
xmldoc/formats/options/xcsv-snwhite.xml
xmldoc/formats/options/xcsv-style.xml
xmldoc/formats/options/xcsv-urlbase.xml
xmldoc/formats/tabsep.xml

index 40cbece72b57e0615c356cc71ad44fe67f3fd875..fdb1ef7e9605c0262b023598593b9a56097de468 100644 (file)
@@ -5,5 +5,5 @@ for debugging purposes when developing a new format module for GPSBabel.
 <para>
 To understand the contents of this file, look at the 
 <filename>style/custom.style</filename> file in the GPSBabel source
-distribution as well as the <link linkend="app_styles">appendix</link>.
+distribution as well as <xref linkend="Styles" />.
 </para>
index f31c58d79e9c8b70ade1bf7bf638e6b4d02e81a7..ce1cadb233f2d6f131dcfd8687d19df458acc504 100644 (file)
@@ -1,4 +1,4 @@
 <para>
 This option specifies the datum to be used on output.  Valid values for this 
-option are listed in <link linkend="Datums">the appendix</link>.
+option are listed in <xref linkend="Datums" />.
 </para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..e3103bd2dcc10c860a401465147cc886ab97d757 100644 (file)
@@ -1 +1,7 @@
-
+<para>
+This option causes GPSBabel to use the short name of the waypoint instead
+of the description.  This overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..9318463ce36300879b2389ba4a1f33db4c2fe7b7 100644 (file)
@@ -1 +1,8 @@
+<para>
+This option specifies the maximum allowable length for a short name on
+output.  This option overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..1687cbec1a14b82a4cf0a6ea5fdb7189ce2f81ce 100644 (file)
@@ -1 +1,8 @@
+<para>
+When this option is specified, GPSBabel will ensure that all short names are
+unique within the output file.  This option overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..99400ee9170d27a0f91be31adc45658ed30ccdb3 100644 (file)
@@ -1 +1,8 @@
+<para>
+When this option is specified, GPSBabel will make all short names contain
+only UPPERCASE characters.  This option overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..1688f0bc9bb9faffc65fe42c41e9cfa4ad9900f8 100644 (file)
@@ -1 +1,7 @@
-
+<para>
+When this option is specified, GPSBabel will allow whitespace (spaces or tabs)
+in generated short names.  This option overrides the style file.
+</para>
+<para>
+Valid values for this option are 0 (off) and 1 (on).
+</para>
index 8b137891791fe96927ad78e64b0aad7bded08bdc..43baf0378703396325d2b4efade0755832f5b3f9 100644 (file)
@@ -1 +1,10 @@
+<para>
+This option specifies the style file that defines the records to be read on
+input or written on output.  This is not a valid option for the various
+built-in xcsv-based styles; they have prebuilt style definitions.
+</para>
+<para>
+For information on the format of xcsv style files, see 
+<xref linkend="Styles" />.
+</para>
 
index 8b137891791fe96927ad78e64b0aad7bded08bdc..781e75c4ce0e5fff2ab52ae0ff82406324becb06 100644 (file)
@@ -1 +1,5 @@
-
+<para>
+This option specifies the base name to prepend to a URL on output.  This 
+might be useful if an input file contains URLs in a relative format and you
+need them to be in an absolute format.
+</para>
index 42c6c113673f4cd649f08a43d662748221ebc375..04f7d1fcf411a8dd735784639f76ead8d4b02744 100644 (file)
@@ -3,8 +3,7 @@ This format, like the <link linkend="fmt_custom">custom</link> format, is
 mainly used for the purpose of testing GPSBabel.  It is supposed to contain
 one field for each piece of information supported by the 
 <link linkend="fmt_xcsv">xcsv</link> format writer, but it may not be entirely
-in sync with the <link linkend="app_styles">appendix</link> that describes 
-those fields.
+in sync with the documentation at <xref linkend="Styles" />.
 </para>
 <para>
 For a list of fields, see the style/tabsep.style file in the GPSBabel source